GET api/units/{unitId}/residents?status[0]={status[0]}&status[1]={status[1]}
Get all residents inside a unit
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
unitId |
Unit id |
integer |
Required |
status |
Optional list of strings representing resident statuses: past, current, future |
Collection of string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ResidentViewModelName | Description | Type | Additional information |
---|---|---|---|
Id |
|
integer |
None. |
UnitId |
|
integer |
None. |
NumberofLateFees |
|
integer |
None. |
NumberofNsfChecks |
|
integer |
None. |
MoveInDate |
|
date |
None. |
MoveOutDate |
|
date |
None. |
LeaseAnniversaryDate |
|
date |
None. |
LeaseExpiratonDate |
|
date |
None. |
OldAccountNumber |
|
string |
None. |
BankAccountId |
|
integer |
None. |
AcceptChecks |
|
integer |
None. |
UnitOwnerBalance |
|
decimal number |
None. |
ReadableResidentId |
|
string |
None. |
ResidentStatusId |
|
integer |
None. |
UnitAddressId |
|
integer |
None. |
BillingAddressId |
|
integer |
None. |
FirstName |
|
string |
None. |
LastName |
|
string |
None. |
MI |
|
string |
None. |
HomePhone |
|
string |
None. |
WorkPhone |
|
string |
None. |
MobilePhone |
|
string |
None. |
OtherPhone |
|
string |
None. |
Gender |
|
string |
None. |
|
string |
None. |
|
MaritalStatus |
|
string |
None. |
ResidentTypeId |
|
integer |
None. |
CheckFree |
|
integer |
None. |
ResidentLateFeePolicyId |
|
integer |
None. |
PrimaryResidentId |
|
integer |
None. |
Comment |
|
string |
None. |
NoticeGiven |
|
date |
None. |
ReceivedDate |
|
date |
None. |
RecordedDate |
|
date |
None. |
EnteredDate |
|
date |
None. |
OPPStatusChangeFlag |
|
boolean |
None. |
NoOfShares |
|
decimal number |
None. |
TotalSecurityDepositRequired |
|
decimal number |
None. |
PayrollDeduction |
|
integer |
None. |
LeaseBeginDate |
|
date |
None. |
ResidentRenewingLeaseStatus |
|
boolean |
None. |
NotRenewingLeaseAsOfDate |
|
date |
None. |
CashPayoffOrderGroup |
|
integer |
None. |
CashPayoffOrderEndDate |
|
date |
None. |
DateCreated |
|
date |
None. |
DateModified |
|
date |
None. |
RealEstateTaxes |
|
decimal number |
None. |
MortgageInterest |
|
decimal number |
None. |
Status |
|
string |
None. |
Unit |
|
UnitViewModel |
None. |
BillingAddress |
|
AddressViewModel |
None. |
FullName |
|
string |
None. |
DisplayName |
|
string |
None. |